home *** CD-ROM | disk | FTP | other *** search
/ Experimental BBS Explossion 3 / Experimental BBS Explossion III.iso / vbasic / dfvb18.zip / DFRAMEVB.DOC < prev    next >
Text File  |  1993-07-19  |  61KB  |  1,169 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.                                D O O R F R A M E
  16.                                   Version 1.8
  17.  
  18.                         A BBS Doors Development Library
  19.                        for the Visual Basic DOS compiler
  20.                       Originally by Ted Freeman (Deceased)
  21.  
  22.                              Copyright (c) July-93
  23.                               by Richard Paquette
  24.                               All rights reserved.
  25.  
  26.  
  27.                                Support board is:
  28.  
  29.                                 The Livewire BBS
  30.                               609-235-5297 USR HST
  31.  
  32.  
  33.  
  34. DOORFRAME v1.8 - Users Guide - Page i
  35.  
  36.  
  37.                                 C O N T E N T S
  38.                                =================
  39.  
  40.         Warranty ............................................ ii
  41.         Copyright notice .................................... ii
  42.         Distribution ........................................ ii
  43.         Description ......................................... ii
  44.         BOX.IT .............................................. 1
  45.         BACK.SPACE .......................................... 2
  46.         CLEARBUFFER ......................................... 2
  47.         CLREOL .............................................. 2
  48.         CLRMOL .............................................. 2
  49.         CLRSOL .............................................. 2
  50.         CLRSCRN ............................................. 2
  51.         DE.LAY .............................................. 2
  52.         DETECT.ANSI ......................................... 2
  53.         DIS.PLAY ............................................ 3
  54.         ENTER ............................................... 4
  55.         EXIT.DOOR ........................................... 4
  56.         IN.PUT .............................................. 4
  57.         INITIALIZE .......................................... 5
  58.         LINES ............................................... 5
  59.         MAKE.BLT ............................................ 6
  60.         MAKE.BLT.CURRENT .................................... 6
  61.         MORE ................................................ 6
  62.         MUSIC ............................................... 6
  63.         OUT.PUT ............................................. 6
  64.         SEND ................................................ 7
  65.         SENDANSI ............................................ 7
  66.         SHOW.BLT ............................................ 7
  67.         COLOR TABLE ......................................... 8
  68.         CONFIGURATION FILE FORMAT ........................... 9
  69.         PCBOARD.SYS VARIABLES ............................... 10
  70.         USERS.SYS VARIABLES ................................. 12
  71.         DOOR.SYS VARIABLES .................................. 13
  72.         USERINFO.DAT VARIABLES .............................. 15
  73.         DORINFOx.DEF VARIABLES .............................. 15
  74.         CALLINFO.BBS VARIABLES .............................. 16
  75.         SFDOORS.DAT VARIABLES ............................... 18
  76.         MISCELLANEOUS NOTES ................................. 20
  77.  
  78.  
  79. DOORFRAME v1.8 - Users Guide - Page ii
  80.  
  81.  
  82.                                    Warranty
  83.  
  84.     This product is provided "as is" without warranty of any kind. The entire
  85.     risk as to the results and  performance of the program is assumed by you.
  86.     Futhermore, the  author does  not warrant, guarantee, or  make any  other
  87.     representations regarding  the use of,  or the  results of the use of the
  88.     program,  and you  rely on the  program and  results  solely at  your own
  89.     risk.  The author  cannot and  will not accept  responsibility for system
  90.     damage, loss of profit, or any other special, consequential or incidental 
  91.     damages  resulting  from  the  use  or  inability  to  use this  product.
  92.  
  93.                                    Copyright
  94.  
  95.     DOORFRAME Copyright (c) 1990-93 by  Ted Freeman  is being distributed as
  96.     Shareware. Under this concept you may use the  SHAREWARE  (unregistered)
  97.     version for a reasonable period of  time for evaluation  after which you
  98.     must either register your copy or discontinue  usage.
  99.  
  100.  
  101.                                  Distribution
  102.  
  103.     You  are encouraged to distribute DOORFRAME provided that all files
  104.     contained in the archive are distributed in their original and
  105.     unmodified state.
  106.  
  107.                                   Description
  108.     
  109.     DOORFRAME is a subroutine library for developing online BBS Doors for
  110.     systems that are compatible with PCBOARD.SYS, USERS.SYS, DOOR.SYS,
  111.     CALLINFO.BBS, USERINFO.DAT, SFDOORS.DAT, or DORINFOx.DEF for
  112.     interfacing to the BBS.
  113.     This version of DoorFrame was written for MicroSoft's Visual Basic for
  114.     DOS (tm). DoorFrame also utilizes some of the routines contained in Tom 
  115.     Hanlin's PBClone library. The COM routines are handled by the QBSerial 
  116.     I/O library.
  117.  
  118.  
  119. DOORFRAME v1.8 - Users Guide - Page 1
  120.  
  121.  
  122.                               DOORFRAME ROUTINES
  123.                              ====================
  124.  
  125. NOTE: 
  126. Since the subroutines are DECLAREd in DFRAMEVB.INC (you DID $INCLUDE: it 
  127. didn't you?) you should not use the CALL statement. Type the name of the 
  128. subroutine and list it's parameters (if any) without the enclosing 
  129. parentheses. For example:
  130.  
  131. DIS.PLAY MSG$,FG%,BG%,BLINK%,BELL%,XPOS%,YPOS%,NL%,CENTER%,CAPS%,CODES%
  132. -----------------------------------------------------------------------------
  133.  
  134. SUBROUTINE: 
  135. BOX.IT SROW%,SCOL%,EROW%,ECOL%,BTYPE%,BFG%,BBG%,FFG%,FBG%,FCHAR%,SHADOW%,TITLE$,HFG%,HBG%
  136. PARAMETERS: SROW%    - ROW the box is to start at. Valid numbers are 1 - 22.
  137.                        Accepts an INTEGER number or variable.
  138.             SCOL%    - COLUMN the box is to start at. Valid numbers are 1 - 79.
  139.                        Accepts an INTEGER number or variable.
  140.             EROW%    - ROW the box is to end at. Valid numbers are 2 - 23.
  141.                        Accepts an INTEGER number or variable.
  142.             ECOL%    - COLUMN the box is to end at. Valid numbers are 2 - 80.
  143.                        Accepts an INTEGER number or variable.
  144.             BTYPE%   - Type of border. Accepts an INTEGER number or variable.
  145.                          0 = No border (spaces all the way around).
  146.                          1 = Single line all the way around.
  147.                          2 = Double line all the way around.
  148.                          3 = Double line on sides, single on top and bottom.
  149.                          4 = Single line on sides, double on top and bottom.
  150.             BFG%     - Foreground color of the border. (See color table)
  151.                        Accepts an INTEGER number or variable.
  152.             BBG%     - Background color of the border. (See color table)
  153.                        Accepts an INTEGER number or variable.
  154.             FFG%     - Foreground color of the box fill characters.
  155.                        Accepts an INTEGER number or variable.
  156.             FBG%     - Background color of the box fill characters.
  157.                        Accepts an INTEGER number or variable.
  158.             FCHAR%   - ASCII number of the character to fill box with.
  159.                        EX: 32 = SPACE, 65 = A, 206 = ╬
  160.             SHADOW%  - -1 = no Shadow, 0 - 7 = Background color of the Shadow. 
  161.                        This will put a Shadow on the right and bottom edges 
  162.                        of the box.
  163.             TITLE$   - Displays a title centered on the top border.
  164.                        Accepts a STRING variable or QUOTED TEXT.
  165.             HFG%     - Foreground color of TITLE$
  166.             HFG%     - Background color of TITLE$
  167.  
  168. DESCRIPTION: Draws a BOX with various style borders. The inside of the
  169.              BOX may be filled with any ASCII character you choose. The
  170.              upper left corner of the screen is ROW 1, COLUMN 1 and the
  171.              bottom right is ROW 23, COLUMN 80.
  172.  
  173.  
  174.  
  175.  
  176. DOORFRAME v1.8 - Users Guide - Page 2
  177.  
  178. SUBROUTINE: BACK.SPACE ROW%, COL%, NUM%
  179. PARAMETERS: ROW%, COL%, NUM%
  180. DESCRIPTION: Backspaces NUM% from the ROW% and COL% specified.
  181.  
  182. SUBROUTINE: CLEARBUFFER BUFF%
  183. PARAMETERS: BUFF%, 0, 1, 2
  184. DESCRIPTION: Clears either the keyboard buffer, the communications input
  185.              buffer, or both.
  186.              0 = Clear both buffers.
  187.              1 = Clear communications input buffer only.
  188.              2 = Clear keyboard buffer only.
  189.  
  190. SUBROUTINE: CLREOL XPOS%, YPOS%, BGC%
  191. PARAMETERS: XPOS%, YPOS%, BGC%
  192. DESCRIPTION: Clears from the specified row and column to the end of that
  193.              line. The line is cleared in whatever color is specified in
  194.              the BGC% parameter. NOTE: Does not work in non-ANSI.
  195.  
  196. SUBROUTINE: CLRMOL XPOS%, YPOS%, LENGTH%, BGC%
  197. PARAMETERS: XPOS%, YPOS%, LENGTH%, BGC%
  198. DESCRIPTION: Clears from the specified row and column for the number of
  199.              columns given in LENGTH%. The line is cleared in whatever
  200.              color is specified in the BGC% parameter.
  201.              NOTE: Does not work in non-ANSI.
  202.  
  203. SUBROUTINE: CLRSOL XPOS%, YPOS%, BGC%
  204. PARAMETERS: XPOS%, YPOS%, BGC%
  205. DESCRIPTION: Clears from the specified row and column to the start of that
  206.              line. The line is cleared in whatever color is specified in
  207.              the BGC% parameter. NOTE: Does not work in non-ANSI.
  208.  
  209. SUBROUTINE: CLRSCRN
  210. PARAMETERS: BGC%
  211. DESCRIPTION: Clears both the LOCAL (if ON) and REMOTE displays in the back-
  212.              ground color of your choice. Range is 0 - 7. ANSI only.
  213.  
  214.  
  215. SUBROUTINE: DE.LAY SEC%
  216. PARAMETERS: SEC%, 1, 2, Etc.
  217. DESCRIPTION: Pauses your program for the number of seconds in SEC%. Accepts
  218.              INTEGER number or variable.
  219.  
  220. SUBROUTINE: DETECT.ANSI
  221. PARAMETERS: None
  222. DESCRIPTION: This routine will determine if the remote system has ANSI
  223.              capability. If the remote system is ANSI compatible, the
  224.              GRAPHICS% variable will be set equal to -1 otherwise it is
  225.              set to 0. This routine does not control whether COLOR is used
  226.              or not, see the MODE% variable for that.
  227.  
  228.  
  229.  
  230. DOORFRAME v1.8 - Users Guide - Page 3
  231.  
  232. SUBROUTINE: 
  233. DIS.PLAY MSG$,FG%,BG%,BLINK%,BELL%,XPOS%,YPOS%,NL%,CENTER%,CAPS%,CODES%
  234. PARAMETERS: MSG$     - Text to be printed in either variable or quoted form.
  235.                        Example: "Print this" or MSG$ = "Print this".
  236.             FG%      - Foreground color (0 - 15) Of the text. Can be in
  237.                        INTEGER number or INTEGER variable form. 
  238.                        Example: FG% = 1, 1, BLUE (See Color Table)
  239.             BG%      - Background color (0 - 7) of text otherwise same as FG%
  240.             BLINK%   - Enter 1 for blinking text or 0 for normal text.
  241.                        Accepts INTEGER number or INTEGER variable.
  242.             BELL%    - Enter 1 to sound a beep on the remote or 0 for no
  243.                        beep. Does not beep on the local computer.
  244.                        Accepts INTEGER number or INTEGER variable.
  245.             XPOS%    - Row number for cursor positioning. Valid numbers
  246.                        are 0 - 23 (status line is on 24 - 25). Enter 0 to
  247.                        disable. Accepts INTEGER number or variable.
  248.                        NOTE: XPOS% is ignored when GRAPHICS% = 0.
  249.             YPOS%    - Column number for cursor positioning. Valid numbers
  250.                        are 0 - 80. Enter 0 to disable. Accepts INTEGER number
  251.                        or INTEGER variable.
  252.                        NOTE: YPOS% is ignored when GRAPHICS% = 0.
  253.             NL%      - Enter 1 to send a CR/LF at the end of the line. Enter
  254.                        0 to position the cursor after the last character.
  255.                        Accepts INTEGER number or INTEGER variable.
  256.             CENTER%  - Enter 1 to center the line or 0 for no centering.
  257.             CAPS%    - Enter 1 to convert text to all uppercase.
  258.                        Enter -1 to convert text to all lowercase.
  259.                        Enter 0 for no case conversion.
  260.                        Accepts INTEGER number or INTEGER variable.
  261.             CODES%   - 0 = No color codes in this statement.
  262.                        1 = Color codes are present in this statement.
  263.  
  264. DESCRIPTION: Displays text to both the Local (if on) and Remote screens.
  265.              Accepts the full ASCII charcter set (0 - 255). Supports ANSI
  266.              color and cursor positioning (XPOS%, YPOS%). DoorFrame features
  267.              auto-ANSI detection and will display in graphics mode if it
  268.              senses ANSI capability on the remote end.
  269.  
  270. ENHANCEMENTS: There are some special symbols available to make text blink
  271.              in the middle of a line in any color you wish. For example:
  272.  
  273.              DIS.PLAY "This will %{Blink Yellow{", LWHITE, BLACK, 0, 0,......
  274.  
  275.              Note the {'s before and after Blink Yellow. They tell the routine
  276.              to display the text in between in yellow and blinks because 
  277.              of the % symbol. Without the % the text is displayed in yellow
  278.              but does not blink. The rest of the line is displayed in white
  279.              on black. The symbols and their corresponding colors are:
  280.                 ~ = Blue,  ` = Green,  @ = Cyan,  ^ = Red,  | = Magenta
  281.                 { = Yellow, and } = White 
  282.              Put a * in front of the first symbol to display in low intensity
  283.              colors. Ex: *}text} displays 'text' in low intensity white. And
  284.              %*}test} displays 'text' in low intensity white and blinks.
  285.  
  286.  
  287. DOORFRAME v1.8 - Users Guide - Page 4
  288.  
  289.              Please note that you must have called DETECT.ANSI before using
  290.              these symbols and the caller must be ANSI capable. Multiple codes
  291.              are allowed in one Dis.Play statement. See the included
  292.              DFDEMO.BAS file for examples on using this option.
  293.              If a particular Dis.Play statement does not contain any of these
  294.              color codes, then the Codes% parameter should contain a 0. This
  295.              will result in a significant increase in display speed since the
  296.              routine doesn't have to search for and strip these characters.
  297.  
  298. SUBROUTINE: ENTER
  299. PARAMETERS: None
  300. DESCRIPTION: Outputs a "Press <ENTER> to Continue" prompt and waits for the
  301.              response. If the caller is in graphics mode, this is centered
  302.              on line 23. In non-graphics mode it is centered 2 lines below
  303.              the last line printed.
  304.  
  305.  
  306. SUBROUTINE: EXIT.DOOR YN$
  307. PARAMETERS: YN$, "Y", "N", "G"
  308. DESCRIPTION: VERY IMPORTANT! Always call this subroutine as the last thing
  309.              your program does. EXIT.DOOR updates the system files with any
  310.              changes that have been made to system variables, closes the
  311.              files, etc.
  312.  
  313.              You can toggle this ON, "Y" or OFF, "N" when you call EXIT.DOOR.
  314.              Accepts a STRING variable YN$ = "Y" or quoted text "Y".
  315.              If you wish to allow the caller to log off from your Door, call
  316.              EXIT.DOOR "G". When you use EXIT.DOOR "G", DoorFrame returns a
  317.              DOS Error Level of 1 for Wildcat! systems and 62 for all others.
  318.  
  319. SUBROUTINE: 
  320. IN.PUT LENGTH%, WAITTIME&, IFG%, IBG%, AUTOCR%, Text$, TFG%, TBG%, X%, Y%, Show%
  321. PARAMETERS: LENGTH%   - Desired length of input. Accepts an INTEGER number
  322.                         or variable. 0 = any length.
  323.             WAITTIME& - Number of seconds to wait for input. If ENTER is not
  324.                         pressed before this times out, control is passed back
  325.                         to the calling routine and RESPONSE$ will contain "-1"
  326.             IFG%      - Foreground color of the response (INTEGER).
  327.             IBG%      - Background color of the response (INTEGER).
  328.             AUTOCR%   - 1 = Automatic CR, 0 = Wait for ENTER to be pressed.
  329.             Text$     - Text to display (if any). Use "" for no display.
  330.             TFG%      - Foreground color of Text$
  331.             BFG%      - Background color of Text$
  332.             X%        - X coordinate to display text. 0 = current coordinate.
  333.             Y%        - Y coordinate to display text. 0 = current coordinate.
  334.             Show%     - 0 = Don't display response, 1 = Display response.
  335.  
  336. DESCRIPTION: Gets a response from the caller which is returned in the variable
  337.              RESPONSE$. Passes ASCII characters in the range 32 - 127 and
  338.              ignores all others unless Hi.Ascii% = 1, in which case it accepts
  339.              ASCII 32 - 255. IN.PUT also allows you to use HOT KEYS! If you are
  340.              prompting for a Y/N you could do something like:
  341.              
  342.              IN.PUT 1, 180, 12, 0, 1, "Is everything correct? (y/n) ", 1, 1, 0
  343.              IF UCASE$(RESPONSE$) = "Y" THEN      Etc., Etc.
  344.  
  345.  
  346. DOORFRAME v1.8 - Users Guide - Page 5
  347.  
  348.              As soon as the caller hit Y or N, the subroutine terminates
  349.              without his having to hit ENTER (however IN.PUT always returns
  350.              when ENTER is pressed). The response would not be displayed.
  351.              The IN.PUT can also be used as a timed routine. In the example
  352.              above, The routine would wait for 180 seconds. if it does not
  353.              receive a keypress within that time, it returns to the calling
  354.              routine and RESPONSE$ would contain a "-1".
  355.              IN.PUT features word-wrap ability in both forward typing and
  356.              while backspacing.
  357.  
  358. SUBROUTINE: INITIALIZE
  359. PARAMETERS: None
  360. DESCRIPTION: VERY IMPORTANT! You MUST make a call to INITIALIZE before your
  361.              code does anything. This subroutine opens the system files and
  362.              obtains all the information you will need to run your Door. It
  363.              first reads the configuration file you passed on the command
  364.              line, then it reads the BBS interface file PCBOARD.SYS, etc.
  365.              There are 3 variables that must be populated before the call
  366.              to INITIALIZE. 
  367.                 PROGNAME$ = "Name of your Door"
  368.                 EXENAME$ = "FILENAM"
  369.                 VERSION$ = " v0.0"
  370.                 INITIALIZE
  371.              PROGNAME$ and VERSION$ are displayed on the Status line after
  372.              the callers name. EXENAME$ must be populated if you plan to use
  373.              the high score bulletin generator. EXENAME$ is the filename of
  374.              your program minus the .EXE extension.
  375.          ->  NOTE: EXENAME$ MUST BE NO MORE THAN 7 CHARACTERS!
  376.  
  377.  
  378. SUBROUTINE: LINES SROW%,SCOL%,LEN%,DIR$,ENDS%,MID%,EFG%,EBG%,MFG%,MBG%
  379. PARAMETERS: SROW%    - Row the line starts at. Valid numbers are 1 - 22.
  380.                        Accepts an INTEGER number or variable.
  381.             SCOL%    - Column the line starts at. Valid numbers are 1 - 79.
  382.                        Accepts an INTEGER number or variable.
  383.             LEN%     - Length of the line. Max. of 23 for vertical, 80 horiz.
  384.                        Accepts an INTEGER number or variable.
  385.             DIR$     - "H" = horizontal. "V" = vertical. Accepts a STRING
  386.                        variable or quoted text.
  387.             ENDS%    - If you are placing the line inside a box, you can
  388.                        make the ends of the line match the box border.
  389.                        Accepts an INTEGER number or variable.
  390.                          0 = No ends. (straight line only)
  391.                          1 = Single line.
  392.                          2 = Double line.
  393.             MID%     - Type of line. 1 = Single line. 2 = Double line.
  394.                        Accepts an INTEGER number or variable.
  395.             EFG%     - Foreground color of the ends (see color table).
  396.                        Accepts an INTEGER number or variable.
  397.             EBG%     - Background color of the ends (see color table).
  398.                        Accepts an INTEGER number or variable.
  399.             MFG%     - Foreground color of the line (see color table).
  400.                        Accepts an INTEGER number or variable.
  401.             MBG%     - Background color of the line (see color table).
  402.                        Accepts an INTEGER number or variable.
  403. DESCRIPTION: Draws either a vertical or horizontal line at the specified
  404.              location. 
  405.  
  406.  
  407. DOORFRAME v1.8 - Users Guide - Page 6
  408.  
  409. SUBROUTINE: MAKE.BLT HI.SCORE&
  410. PARAMETERS: HI.SCORE&, 10, 10000, Etc.
  411. DESCRIPTION: This routine will write a hi-score bulletin listing the top ten
  412.              scores. The parameter passed must be a LONG INTEGER (&). This
  413.              routine creates a file called FILENAME.BUL (where FILENAME is
  414.              the same as specified in the EXENAME$ variable). The first line
  415.              of this .BUL file indicates the path to the actual BLT file. It
  416.              initially writes FILENAME.BLT. If you wish to have a different
  417.              filename (such as BLT1) you must edit this line. The filename
  418.              for your BLT file should be 7 characters or less because
  419.              DoorFrame also writes a graphics BLT and appends a G to the
  420.              filename. (You should also explain this to your user Sysops!)
  421.  
  422. SUBROUTINE: MAKE.BLT.CURRENT HI.SCORE&
  423. PARAMETERS: HI.SCORE&, 10, 10000, Etc.
  424. DESCRIPTION: Same as MAKE.BLT except it posts CURRENT scores rather than
  425.              highest scores.
  426.  
  427.  
  428. SUBROUTINE: MORE
  429. PARAMETERS: None
  430. DESCRIPTION: Outputs "Press <ENTER> to continue, or <E> to end" and waits
  431.              for a response. Check the variable RESPONSE$ for an "E" and
  432.              terminate the current routine if found. For example:
  433.                 MORE
  434.                 IF UCASE$(RESPONSE$) = "E" THEN
  435.                   Etc.. Etc.
  436.  
  437. SUBROUTINE: MUSIC TUNE$
  438. PARAMETERS: MUSIC CODES
  439. DESCRIPTION: Outputs music to the remote system. The TUNE$ parameter
  440.              contains the same codes you would normally use in the BASIC
  441.              PLAY statement. For example:
  442.               TUNE$ = "t110 l8 ms d4 mn o3 g a b o4 c ... "
  443.               MUSIC TUNE$
  444.              Since not all communications programs can handle music, you
  445.              should ask the user if he has music capabilities. If the
  446.              user can't handle music he will simply see the music codes
  447.              come across his screen (not a pretty sight!).
  448.  
  449.  
  450. SUBROUTINE: OUT.PUT LF%
  451. PARAMETERS: LF%, 1, 2, Etc.
  452. DESCRIPTION: Outputs the specified number of CR/LF. Parameter is an INTEGER
  453.              number or an INTEGER variable. Ex: OUT.PUT 2
  454.  
  455.  
  456.  
  457. DOORFRAME v1.8 - Users Guide - Page 7
  458.  
  459. SUBROUTINE: SEND FILENAME$, YN%, CLR%
  460. PARAMETERS: FILENAME$ - STRING variable or quoted text of file to SEND.
  461.             YN%       - 0 = Do not use the ENTER prompt after last page.
  462.                         1 = Use the ENTER prompt after last page.
  463.             CLR%      - 0 = Home cursor, do not clear screen.
  464.                         1 = Normal clear screen.
  465. DESCRIPTION: Sends the specified filename. This can be either an ASCII file
  466.              or an ANSI file. SEND first checks for the existance of the file
  467.              and either sends the file or reports "File not Found!". This is
  468.              handy for displaying Help files, Welcome screens, etc.
  469.        NOTE: When using The Draw to create ANSI screens, save the screen using
  470.              the block mode (ALT-B) as this seems to produce better results
  471.              than using the regular save function (ALT-S).
  472.  
  473.  
  474. SUBROUTINE: SENDANSI FILENAME$, YN%, INTER%
  475. PARAMETERS: FILENAME$ - STRING variable or quoted text of file to send.
  476.             YN%       - 0 = Do not use the ENTER prompt after last page.
  477.                         1 = Use the ENTER prompt after last page.
  478.                         2 = Pause at end for Spacebar. Doesn't print anything
  479.             INTER%    - 0 = User can interrupt and exit the screen anytime.
  480.                         1 = User cannot interrupt file until it is finished.
  481. DESCRIPTION: Sends the specified ANSI file if it exists. This routine does
  482.              not stop until the entire file has been sent. Pressing the
  483.              Spacebar during display aborts the file unless Inter% is set
  484.              to 1.
  485.  
  486.  
  487. SUBROUTINE: SHOW.BLT YN$
  488. PARAMETERS: YN$, "Y", "N"
  489. DESCRIPTION: Call this routine if your Door features a Hi-score bulletin. Make
  490.              sure you have called MAKE.BLT first! Best place to call this
  491.              is just before you call EXIT.DOOR. For example:
  492.                MAKE.BLT HI.SCORE&
  493.                SHOW.BLT "Y"
  494.                EXIT.DOOR "Y"
  495.              SHOW.BLT "Y" will ask if they want to see the Bulletin.
  496.              SHOW.BLT "N" displays the bulletin without asking.
  497.  
  498.  
  499. DOORFRAME v1.8 - Users Guide - Page 8
  500.  
  501.  
  502.                              C O L O R  T A B L E
  503.                             ======================
  504.  
  505. COLOR # - NAME       INTENSITY       FOREGROUND (FG%)     BACKGROUND (BG%)
  506. ---------------------------------------------------------------------
  507.  0 - BLACK              Low               X                   X
  508.  1 - BLUE                "                X                   X
  509.  2 - GREEN               "                X                   X
  510.  3 - CYAN                "                X                   X
  511.  4 - RED                 "                X                   X
  512.  5 - MAGENTA             "                X                   X
  513.  6 - YELLOW              "                X                   X
  514.  7 - WHITE               "                X                   X
  515.  8 - GRAY               High              X
  516.  9 - LBLUE               "                X
  517. 10 - LGREEN              "                X
  518. 11 - LCYAN               "                X
  519. 12 - LRED                "                X
  520. 13 - LMAGENTA            "                X
  521. 14 - LYELLOW             "                X
  522. 15 - LWHITE              "                X
  523.  
  524. The COLORs are defined as CONSTANT in the DFRAMEX.INC file so you may use
  525. either the actual color number, it's name or an INTEGER variable of your own
  526. choosing when CALLing the DIS.PLAY subroutine.
  527.  
  528.  
  529.  
  530. DOORFRAME v1.8 - Users Guide - Page 9
  531.  
  532.  
  533.                               CONFIGURATION FILE
  534.                               ==================
  535.  
  536. The format of the configuration file used by Doors created with DoorFrame is:
  537.  
  538. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  539. C|\PCB\USERS.SYS                <- For PCBoard systems using USERS.SYS
  540. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  541. C:\BBS\GTUSER.BBS               <- For GT Power systems
  542. C:\BBS\USERINFO.DAT             <- For Wildcat! 3.x+ systems.
  543. C:\BBS\DOOR.SYS                 <- For systems that support DOOR.SYS
  544. C:\BBS\DORINFOx.DEF             <- For QBBS/RBBS/RA. Replace x with Node #.
  545. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  546. C:\BBS\TRIBBS.SYS               <- For TriBBS systems.
  547. MicroNet                        <- BBS name
  548. Ted                             <- Sysop's first name
  549. Freeman                         <- Sysop's last name
  550.   .                             <- The Configuration file is left open as #1
  551.   .                                so you may add whatever is necessary.
  552.  
  553. NOTE: See Miscellaneous Notes for info on using Environment Variables.
  554.  
  555. NOTE: There are 2 additional lines necessary when using GTUSER.BBS. Since
  556.       this file does not provide the ComPort% and NodeNum% variables, advise
  557.       your Door users to add them to this .CFG file on lines 5 and 6
  558.       respectively. Both variables will default to 1.
  559.  
  560. DOORFRAME v1.8 - Users Guide - Page 10
  561.  
  562.                   VARIABLES AVAILABLE WHEN USING PCBOARD.SYS
  563.                   ==========================================
  564.  
  565.         ALLOWEDBYTES&             Allowed D/L bytes from the PWRD file.
  566.                                   This number is in actual bytes
  567.                                   rather than Kilobytes allowed.
  568.       * BAUDCONN$                 Connect rate of caller or "LOCAL"
  569.       * BAUDOPEN$                 Port opening BPS
  570.       * BBSSYS$                   Name of the BBS
  571.         CALLALARM%                Caller alarm status.     -1=ON, 0=OFF
  572.       * CALLERSLOC$               Location of CALLERSx log
  573.         CHATSTATUS$               Chat mode status. "U" or "A"
  574.       * CITY$                     Callers city and state
  575.       * CNAMESLOC$                Location of CNAMES
  576.       * COMPORT%                  COM port number
  577.         CONFREG$                  Conferences registered in
  578.         DISPLAY%                  Local display status.    -1=ON, 0=OFF
  579.         DOWNLOADS&                Number of downloads made
  580.       * ECC%                      Error corrected connect.  1=YES, 0=NO
  581.         EXENAME$                  Name of .EXE (Programmer supplied)
  582.         EXPERT$                   Expert mode - "Y" or "N"
  583.         EXPIRE$                   Callers expiration date
  584.       * FIRST$                    Callers first name
  585.         GRAPHICS%                 Graphics mode status.    -1=ON, 0=OFF
  586.                                   Determines if the caller is ANSI compatible
  587.                                   If your door requires the use of cursor
  588.                                   positioning and GRAPHICS% = 0 then you
  589.                                   should kick him back out of the door.
  590.       * HPHONE$                   Callers home phone number
  591.       * LASTON$                   Date caller last logged on (MM-DD-YY)
  592.         LEVEL&                    Callers security level
  593.       * LOCALUSR%                 -1 = LOCAL mode, 0 = Online
  594.       * LOGONHRS$                 Time caller logged on in HH:MM format
  595.       * LOGONMINS%                Time caller logged on in minutes
  596.         MODE%                     0 = Non-color, -1 = color is on. Default
  597.                                   is the BBS setting. You may force color
  598.                                   by setting this to -1.
  599.       * NAME$                     Callers full name
  600.       * NETWORK%                  1 = BBS is networked, 0 = no network
  601.       * NODENUM%                  Node number
  602.         OWNER$                    Name DoorFrame is registered to (if any).
  603.         PASSWORD$                 Password of caller
  604.         PAGEBELL%                 Page bell status.        -1=ON, 0=OFF
  605.         PAGELEN%                  Callers page length
  606.       * PCBDAT$                   Location of PCBOARD.DAT
  607.       * PCBOARD%                  1 = PCBoard, 0 = non-PCBoard
  608.         PRINTER%                  Printer status.          -1=ON, 0=OFF
  609.         PROGNAME$                 Name of DOOR (Programmer supplied)
  610.         PROTOCOL$                 Caller's default protocol (Z, X, etc.)
  611.         RESPONSE$                 Returned after a CALL to IN.PUT
  612.         SERIAL$                   Your DoorFrame serial #. String variable.
  613.       * SYSLOC$                   Location of system file. This contains the
  614.                                   path/filename of line 1 in the .CFG file.
  615.       * SYSOP%                    1 = SYSOP is using DOOR, 0 otherwise
  616.       * SYSOPFIRST$               Sysops first name
  617.         SYSOPFLAG$                " ", "N"=Sysop Next, "X"=Exit to DOS
  618.       * SYSOPLAST$                Sysops last name
  619.       * SYSOPNAME$                Sysops first and last names
  620.  
  621.  
  622. DOORFRAME v1.8 - Users Guide - Page 11
  623.  
  624.  
  625.         TIMEADJUST%               Use to adjust the callers remaining time
  626.                                   online. This variable adjusts the ELAPSED
  627.                                   time so if you wish to decrease his time,
  628.                                   give this a positive value.
  629.       * TIMEALWD%                 Minutes caller is allowed
  630.       * TIMELEFT%                 Time caller has left in minutes. Doorframe
  631.                                   calculates this so changing it has no effect
  632.       * TIMENOW%                  Current time in minutes (0 - 1440)
  633.       * TIMESON%                  Number of times on system
  634.         TIMEOUT%                  Programmer supplied keyboard timeout.
  635.                                   Defaults to 300 (5 mins) if not specified. 
  636.                                   Has a minimum of 60 seconds. Maximum is 
  637.                                   32,767 since it's an integer.
  638.       * TIMEUSED%                 Time used so far today in minutes
  639.         UPLOADS&                  Number of uploads made
  640.       * USERCOMMENT$              User maintained comment
  641.       * USERSLOC$                 Location of USERS file
  642.       * USERNUM%                  Record number of caller
  643.         VERSION$                  DOOR version # (Programmer supplied)
  644.       * WPHONE$                   Callers work phone number
  645.  
  646. NOTES: Variables marked with '*' are provided for information only.
  647.  
  648.  
  649. DOORFRAME v1.8 - Users Guide - Page 12
  650.  
  651.  
  652.                    VARIABLES AVAILABLE WHEN USING USERS.SYS
  653.                    ========================================
  654.  
  655.         When using USERS.SYS, all variables contained in PCBOARD.SYS may
  656.         be used plus the following additional variables.
  657.  
  658.         DAILYDNLDBYTES&          Bytes downloaded so far today.
  659.         DELETEFLAG%              1 = delete this record, 0 = keep
  660.         EXPIREDLEVEL&            Expired Security level
  661.         LASTCONF%                Conference number last in.
  662.         LASTTIMEON$              Last time caller was on
  663.         MSGS.LEFT%               Number of messages posted
  664.         MSGS.READ%               Number of messages read
  665.         PCB.VERSION%             PCBoard version number (i.e. 1450)
  666.         TOTDNLDBYTES&            Total number of BYTES downloaded
  667.         TOTUPLDBYTES&            Total number of BYTES uploaded
  668.  
  669. NOTES: These variables are all passed back to PCBoard.
  670.  
  671.  
  672. DOORFRAME v1.8 - Users Guide - Page 13
  673.  
  674.                     VARIABLES AVAILABLE WHEN USING DOOR.SYS
  675.                     =======================================
  676.  
  677.     !   ALIAS$                    Callers alias/handle
  678.     ! * ANSISUPPORT$              Caller supports ANSI but in NG mode
  679.       * BAUDCONN$                 Connect rate of caller or "LOCAL"
  680.       * BAUDOPEN$                 Port opening BPS
  681.     ! * BBSCOLOR%                 BBS default color code (1-15)
  682.       * BBSSYS$                   Name of the BBS
  683.         BIRTHDATE$                Callers date of birth
  684.         CALLALARM%                Caller alarm status.     -1=ON, 0=OFF
  685.       * CITY$                     Callers city and state
  686.       * COMPORT%                  COM port number (1 - 4).
  687.         CONFREG$                  Conferences registered in
  688.         DAILY.BYTES.ALWD&         Daily download max. K limit
  689.         DISPLAY%                  Local display status.    -1=ON, 0=OFF
  690.     !   DOORS.OPENED%             Number of Doors caller has opened
  691.         DOWNLOADS&                Number of downloads made
  692.     ! * ECC%                      Error corrected connect.  1=YES, 0=NO
  693.         EXENAME$                  Name of .EXE (Programmer supplied)
  694.         EXFROM%                   Conference exited to Door from.
  695.         EXPERT$                   Expert mode - "Y" or "N"
  696.         EXPIRE$                   Callers expiration date
  697.     ! * EVENT$                    Event time (hh:mm)
  698.         GRAPHICS%                 Graphics mode status.    -1=ON, 0=OFF
  699.                                   Determines if the caller is ANSI compatible
  700.                                   If your door requires the use of cursor
  701.                                   positioning and GRAPHICS% = 0 then you
  702.                                   should kick him back out of the door.
  703.       * HPHONE$                   Callers home phone number
  704.       * LASTON$                   Date caller last logged on (MM-DD-YY)
  705.     !   LASTSCAN$                 Date of last directory/new files scan.
  706.         LEVEL&                    Callers security level
  707.       * LOCALUSR%                 -1 = LOCAL mode, 0 = Online
  708.       * LOGONHRS$                 Time caller logged on in HH:MM format
  709.       * LOGONMINS%                Time caller logged on in minutes
  710.     !   MAX.FILES%                Maximum daily files available
  711.     !   MINSCREDIT%               Time credits in minutes
  712.         MODE%                     0 = Non-color, -1 = color is on. Default
  713.                                   is the BBS setting. You may force color
  714.                                   by setting this to -1.
  715.     !   MSGS.LEFT%                Total messages left
  716.       * NAME$                     Callers full name
  717.     ! * NETWORK%                  1 = BBS is networked, 0 = no network
  718.       * NODENUM%                  Node number
  719.         DLTODAY&                  Files downloaded so far today
  720.         OWNER$                    Name DoorFrame is registered to (if any).
  721.         PAGEBELL%                 Page bell status.        -1=ON, 0=OFF
  722.         PAGELEN%                  Callers page length
  723.       * PARITY%                   Parity (word length?) (7 or 8)
  724.         PASSWORD$                 Password of caller
  725.       * PATHGEN$                  Path to the GEN directory
  726.       * PATHMAIN$                 Path to the MAIN directory
  727.         PRINTER%                  Printer status.          -1=ON, 0=OFF
  728.         PROGNAME$                 Name of DOOR (Programmer supplied)
  729.         PROTOCOL$                 Callers default protocol (Z, X, etc)
  730.         RESPONSE$                 Returned after a CALL to IN.PUT
  731.  
  732.  
  733. DOORFRAME v1.8 - Users Guide - Page 14
  734.  
  735.  
  736.         SECREM$                   Number of seconds remaining this call.
  737.         SERIAL$                   Your DoorFrame serial #. String variable.
  738.       * SYSLOC$                   Location of system file. This contains the
  739.                                   path/filename of line 1 in the .CFG file.
  740.       * SYSOP%                    1 = SYSOP is using DOOR, 0 otherwise
  741.       * SYSOPFIRST$               Sysops first name
  742.       * SYSOPLAST$                Sysops last name
  743.       * SYSOPNAME$                Sysops first and last names
  744.         TIMEADJUST%               Use to adjust the callers remaining time
  745.                                   online. This variable adjusts the ELAPSED
  746.                                   time so if you wish to decrease his time,
  747.                                   give this a positive value.
  748.     ! * TIMELASTCALL$             Time of last call (hh:mm)
  749.       * TIMELEFT%                 Time caller has left in minutes. Doorframe
  750.                                   calculates this so changing it has no effect
  751.       * TIMENOW%                  Current time in minutes (0 - 1440)
  752.         TIMEOUT%                  Programmer supplied. Defaults to 5 mins if
  753.                                   not specified. Has a minimum of one min.
  754.                                   No limit on maximum. 
  755.       * TIMESON%                  Number of times on system
  756.       * TIMEUSED%                 Time used so far today in minutes
  757.         TOTAL.BYTES.TODAY&        Daily download K total
  758.     !   TOTAL.KB.DL&              Total K bytes downloaded
  759.     !   TOTAL.KB.UL&              Total K bytes uploaded
  760.         UPLOADS&                  Number of uploads made
  761.       * USERCOMMENT$              User maintained comment
  762.       * USERNUM%                  Record number of caller
  763.         VERSION$                  DOOR version # (Programmer supplied)
  764.       * WPHONE$                   Callers work phone number
  765. NOTES: Variables marked with '*' are provided for information only.
  766.        Varialbes marked with '!' are available only in the 52 line version.
  767.  
  768.  
  769. DOORFRAME v1.8 - Users Guide - Page 15
  770.  
  771.                   VARIABLES AVAILABLE WHEN USING USERINFO.DAT
  772.                   ===========================================
  773.  
  774.       * ACTIVE.MENU%              0=Main, 1=Msg, 2=File, 3=Sysop
  775.         ALIAS$                    Callers alias/handle
  776.       * ANSISUPPORT$              'Y' or 'N' for ANSI enabled.
  777.         BANKED.TIME%              Banked time. (DLT - MaxLogOn)
  778.       * BAUDCONN$                 Connect rate of caller or "LOCAL"
  779.       * COMMAND.LINE$             Started with a CommandLine switch. Y or N.
  780.       * DATABITS$                 Databits, 7 or 8.
  781.       * DOOR.LOGOFF$              Y or N. Set to Y if caller logged off from
  782.                                   inside the door.
  783.         DOOR.DL&                  Number of files DL'ed in the door.
  784.         DOOR.KB&                  Downloads in K, add to daily and total bytes
  785.       * ECC%                      Error corrected connect.  1=YES, 0=NO
  786.         LASTSCAN$                 Time/date of last new files scan
  787.       * LOGONTIMEDATE$            Time and date caller logged on to BBS
  788.       * NAME$                     Callers full name
  789.         SEC.LEVEL.NAME$           Security level name.
  790. NOTES: Variables marked with '*' are provided for information only.
  791.        All other variables are taken from the DOOR.SYS file.
  792.  
  793.                   VARIABLES AVAILABLE WHEN USING DORINFOx.DEF
  794.                   ===========================================
  795.  
  796.       * BAUDRATE$                 Baud rate and parity of caller.
  797.                                   Ex. 2400 BAUD,N,8,1
  798.                                   NOTE: RBBS adds baud rate of BBS.
  799.       * BBSSYS$                   Name of the BBS
  800.       * CITY$                     Callers city and state
  801.       * COMPORT%                  COM port number (1 - 4).
  802.         DISPLAY%                  Defaults to -1 (ON).
  803.       * DORINFO13TH$              13th line available only on RBBS systems.
  804.         EXENAME$                  Name of .EXE (Programmer supplied)
  805.       * FIRST$                    Callers first name
  806.         GRAPHICS%                 Graphics mode status.    -1=ON, 0=OFF
  807.                                   Determines if the caller is ANSI compatible
  808.                                   If your door requires the use of cursor
  809.                                   positioning and GRAPHICS% = 0 then you
  810.                                   should kick him back out of the door.
  811.                                   Use DETECT.ANSI to determine this.
  812.       * LAST$                     Callers last name
  813.       * LASTON$                   Default 01-01-80 (not provided in DORINFO)
  814.         LEVEL&                    Callers security level
  815.       * LOCALUSR%                 -1 = LOCAL mode, 0 = Online
  816.         MODE%                     0 = Non-color, -1 = color is on. Default
  817.                                   is the BBS setting. You may force color
  818.                                   by setting this to -1.
  819.       * NAME$                     Callers full name
  820.         NETWORK$                  Network type. DoorFrame reads/writes as is.
  821.       * NODENUM%                  Number of this Node.
  822.         OWNER$                    Name DoorFrame is registered to (if any).
  823.         PROGNAME$                 Name of DOOR (Programmer supplied)
  824.         RESPONSE$                 Returned after a CALL to IN.PUT
  825.         SERIAL$                   Your DoorFrame serial #. String variable.
  826.       * SYSLOC$                   Location of system file. This contains the
  827.                                   path/filename of line 1 in the .CFG file.
  828.  
  829.  
  830. DOORFRAME v1.8 - Users Guide - Page 16
  831.  
  832.       * SYSOP%                    1 = SYSOP is using DOOR, 0 otherwise
  833.       * SYSOPFIRST$               Sysops first name
  834.       * SYSOPLAST$                Sysops last name
  835.       * SYSOPNAME$                Sysops first and last names
  836.         TIMEADJUST%               Use to adjust the callers remaining time
  837.                                   online. This variable adjusts the ELAPSED
  838.                                   time so if you wish to decrease his time,
  839.                                   give this a positive value.
  840.       * TIMELEFT%                 Time caller has left in minutes. Doorframe
  841.                                   calculates this so changing it has no effect
  842.       * TIMENOW%                  Current time in minutes (0 - 1440)
  843.         TIMEOUT%                  Programmer supplied. Defaults to 5 mins if
  844.                                   not specified. Has a minimum of one min.
  845.                                   No limit on maximum. 
  846.       * TIMESON%                  Defaults to 1 (Not provided in DORINFO)
  847.       * TIMEUSED%                 Time used so far today in minutes
  848.  
  849. NOTES: Variables marked with '*' are provided for information only.
  850.  
  851.  
  852.                   VARIABLES AVAILABLE WHEN USING CALLINFO.BBS
  853.                   ===========================================
  854.  
  855.       * ALREADYCONNECTED$         "TRUE" or "FALSE"
  856.       * BAUDCONN$                 Connect rate of caller or "LOCAL"
  857.       * BBSSYS$                   Name of the BBS
  858.       * CITY$                     Callers city and state
  859.       * COMPORT%                  COM port number (1 - 4).
  860.         CONFREG$                  Conferences registered in (ABCD etc.)
  861.       * CONSOLE$                  "LOCAL" or "REMOTE"
  862.         DAILY.BYTES.ALWD&         Daily download max. K limit
  863.       * DATABITS$                 7 or 8
  864.         DISPLAY%                  Local display status.    -1=ON, 0=OFF
  865.       * DOORNUMBER$               BBS number of this door?
  866.         EXENAME$                  Name of .EXE (Programmer supplied)
  867.       * ENTERDOOR$                Time caller entered door in HH:MM format.
  868.       * FIRST$                    Callers first name
  869.         GRAPHICS%                 Graphics mode status.    -1=ON, 0=OFF
  870.                                   Determines if the caller is ANSI compatible
  871.                                   If your door requires the use of cursor
  872.                                   positioning and GRAPHICS% = 0 then you
  873.                                   should kick him back out of the door.
  874.                                   Use DETECT.ANSI to determine this.
  875.       * LAST$                     Callers last name
  876.         LASTMSG$                  Last message read
  877.       * LASTONDATE$               Date and time of last call
  878.         LEVEL&                    Callers security level
  879.       * LOCALUSR%                 -1 = LOCAL mode, 0 = Online
  880.       * LOGONTIMEDATE$            Time and date caller logged on to BBS
  881.       * LOGONHRS$                 Time caller logged on in HH:MM format
  882.         MODE%                     0 = Non-color, -1 = color is on. Default
  883.                                   is the BBS setting. You may force color
  884.                                   by setting this to -1.
  885.       * MNP$                      "MNP/ARQ Connection" or "Normal Connection"
  886.       * NAME$                     Callers full name
  887.         DLTODAY&                  Files downloaded so far today
  888.  
  889.  
  890. DOORFRAME v1.8 - Users Guide - Page 17
  891.  
  892.         OWNER$                    Name DoorFrame is registered to (if any).
  893.         PASSWORD$                 Password of caller
  894.         PROGNAME$                 Name of DOOR (Programmer supplied)
  895.         RESPONSE$                 Returned after a CALL to IN.PUT
  896.         SERIAL$                   Your DoorFrame serial #. String variable.
  897.       * SYSLOC$                   Location of system file. This contains the
  898.                                   path/filename of line 1 in the .CFG file.
  899.       * SYSOP%                    1 = SYSOP is using DOOR, 0 otherwise
  900.       * SYSOPFIRST$               Sysops first name
  901.       * SYSOPLAST$                Sysops last name
  902.       * SYSOPNAME$                Sysops first and last names
  903.         TIMEADJUST%               Use to adjust the callers remaining time
  904.                                   online. This variable adjusts the ELAPSED
  905.                                   time so if you wish to decrease his time,
  906.                                   give this a positive value.
  907.       * TIMELEFT%                 Time caller has left in minutes. Doorframe
  908.                                   calculates this so changing it has no effect
  909.       * TIMENOW%                  Current time in minutes (0 - 1440)
  910.       * TIMEOFF$                  Time caller exited from the door.
  911.         TIMEOUT%                  Programmer supplied. Defaults to 5 mins if
  912.                                   not specified. Has a minimum of one min.
  913.                                   No limit on maximum. 
  914.       * TIMEUSED%                 Time used so far today in minutes
  915.       * USERNUM%                  Record number of caller
  916.  
  917. NOTES: Variables marked with '*' are provided for information only.
  918.  
  919.  
  920. DOORFRAME v1.8 - Users Guide - Page 18
  921.  
  922.                   VARIABLES AVAILABLE WHEN USING SFDOORS.DAT
  923.                   ==========================================
  924.  
  925.         ANSION$                   "TRUE" or "FALSE"
  926.       * BAUDCONN$                 Connect rate of caller or "LOCAL"
  927.       * BBSDIR$                   Spitfire's home directory
  928.       * BBSSYS$                   Name of the BBS
  929.       * CITY$                     Callers city and state
  930.       * COMPORT%                  COM port number (1 - 4).
  931.         DAILY.BYTES.ALLOWED&      Maximum download BYTES per day
  932.         DISPLAY%                  Local display status.    -1=ON, 0=OFF
  933.         DLPERDAY&                 Number of downloads allowed per day
  934.         DLTODAY&                  Number of downloads made today
  935.         DOWNLOADS&                Number of downloads made
  936.       * ECC%                      Error corrected connect.  1=YES, 0=NO
  937.         EXENAME$                  Name of .EXE (Programmer supplied)
  938.         EXTRATIME&                Number of seconds gained since logon
  939.       * FIRST$                    Callers first name
  940.       * FRONTEND$                 "TRUE" or "FALSE" if booted from a
  941.                                   front end program.
  942.         GRAPHICS%                 Graphics mode status.    -1=ON, 0=OFF
  943.                                   Determines if the caller is ANSI compatible
  944.                                   If your door requires the use of cursor
  945.                                   positioning and GRAPHICS% = 0 then you
  946.                                   should kick him back out of the door.
  947.                                   Use DETECT.ANSI to determine this.
  948.       * HPHONE$                   Callers home phone number
  949.       * LAST$                     Callers last name
  950.         LASTMCONF$                Last message conference
  951.         LASTFAREA$                Last file area
  952.         LEVEL&                    Callers security level
  953.       * LOCALUSR%                 -1 = LOCAL mode, 0 = Online
  954.       * LOGONHRS$                 Time caller logged on in HH:MM format
  955.       * LOGONSECS&                Number of seconds since midnight
  956.                                   when caller logged on to the BBS.
  957.       * MAXBAUD$                  Maximum baud of the system
  958.         MODE%                     0 = Non-color, -1 = color is on. Default
  959.                                   is the BBS setting. You may force color
  960.                                   by setting this to -1.
  961.       * NAME$                     Callers full name
  962.       * NODENUM%                  Number of this Node.
  963.       * NODTELOCK$                "TRUE" or "FALSE" if configured for
  964.                                   software data flow control.
  965.         OWNER$                    Name DoorFrame is registered to (if any).
  966.         PASSWORD$                 Password of caller
  967.         PROGNAME$                 Name of DOOR (Programmer supplied)
  968.         RESPONSE$                 Returned after a CALL to IN.PUT
  969.       * SECONDS&                  Number of seconds since midnight
  970.                                   when caller entered the door.
  971.         SERIAL$                   Your DoorFrame serial #. String variable.
  972.       * SYSLOC$                   Location of system file. This contains the
  973.                                   path/filename of line 1 in the .CFG file.
  974.       * SYSOP%                    1 = SYSOP is using DOOR, 0 otherwise
  975.       * SYSOPFIRST$               Sysops first name
  976.  
  977. NOTES: Variables marked with '*' are provided for information only.
  978.  
  979.  
  980. DOORFRAME v1.8 - Users Guide - Page 19
  981.  
  982.       * SYSOPLAST$                Sysops last name
  983.       * SYSOPNAME$                Sysops first and last names
  984.         SYSOPNEXT$                "TRUE" or "FALSE"
  985.         TIMEADJUST%               Use to adjust the callers remaining time
  986.                                   online. This variable adjusts the ELAPSED
  987.                                   time so if you wish to decrease his time,
  988.                                   give this a positive value.
  989.       * TIMEALWD%                 Minutes caller is allowed
  990.       * TIMELEFT%                 Time caller has left in minutes. Doorframe
  991.                                   calculates this so changing it has no effect
  992.       * TIMENOW%                  Current time in minutes (0 - 1440)
  993.         TIMEOUT%                  Programmer supplied. Defaults to 5 mins if
  994.                                   not specified. Has a minimum of one min.
  995.                                   No limit on maximum. 
  996.       * TIMEUSED%                 Time used so far today in minutes
  997.  
  998.         TOTAL.BYTES.TODAY&        BYTES downloaded so far today
  999.         TOTAL.KB.DL&              Total K bytes downloaded
  1000.         TOTAL.KB.UL&              Total K bytes uploaded
  1001.         UPLOADS&                  Number of uploads made
  1002.       * USERNUM%                  Record number of caller
  1003.  
  1004. NOTES: Variables marked with '*' are provided for information only.
  1005.  
  1006.  
  1007. DOORFRAME v1.8 - Users Guide - Page 20
  1008.  
  1009.                                 MISCELLANEOUS NOTES
  1010.                                 ===================
  1011.  
  1012. Check DFRAMEX.INC for an explanation of variables not listed above.
  1013.  
  1014. DoorFrame requires DOS 3.x and up since all files are opened in SHARED mode.
  1015.  
  1016. When using PCBOARD.SYS, DoorFrame also accesses the USERS file.
  1017.  
  1018. When using USERS.SYS, DoorFrame also accesses PCBOARD.SYS, PCBOARD.DAT and the 
  1019. USERS file.
  1020.  
  1021. The DOOR.SYS used by DoorFrame is the standard 52 line GAP (tm) file.
  1022.  
  1023. The CALLINFO.BBS used by DoorFrame currently contains 36 lines.
  1024.  
  1025. Trapping errors
  1026. ---------------
  1027.  If you wish to utilize the internal error trapping, insert the following
  1028.  line wherever you wish the trapping to begin. I would suggest putting it
  1029.  right after you call INITIALIZE.
  1030.  
  1031.    ON ERROR GOTO ERR.ROUTINE
  1032.  
  1033.  Then at the very end of your program insert the following:
  1034.  
  1035.    ERR.ROUTINE:
  1036.    ERRORS ERR, ERL
  1037.    END
  1038.  
  1039.  If ANY Basic error is encountered, it will branch to ERR.ROUTINE and call
  1040.  the ERRORS subroutine. The error will be printed to the screen and written
  1041.  to DFRAME.ERR. Your Door will then exit back to the BBS.
  1042. The first few lines of your Door should be:
  1043.  
  1044.    ' $INCLUDE: 'DFRAMEX.INC'
  1045.    PROGNAME$ = "Name of the Door"
  1046.    VERSION$ = " v1.8"
  1047.    EXENAME$ = "FILENAM"           <- NOTE: Max of 7 letters!
  1048.    TIMEOUT% = 240                 <- Numbers of seconds to wait for keyboard
  1049.                                      activity. 240 will wait for 4 minutes
  1050.                                      then send a Keyboard Timeout msg. and
  1051.                                      exit back to the BBS. Defaults to 300.
  1052.    OWNER$ = "Your Name"           <- For registered DoorFrame users only.
  1053.    SERIAL$ = "99999"              <- DoorFrame will display an EVALUATION
  1054.                                      COPY message until registered.
  1055.    INITIALIZE
  1056.    .
  1057.    Your code.......
  1058.    .
  1059.    MAKE.BLT HI.SCORE&            <- If you want one generated.
  1060.    SHOW.BLT "Y"                  <- If you want to show it before door closes.
  1061.    EXIT.DOOR "Y"
  1062. The configuration filename passed on the command line is OPENed as #1. This
  1063. file is left open so you may read additional lines from the .CFG file. 
  1064. Although it is not absolutely necessary, you should CLOSE #1 somewhere near
  1065. the start of your program.
  1066.  
  1067.  
  1068. DOORFRAME v1.8 - Users Guide - Page 21
  1069.  
  1070. Using SysopKeys%
  1071. ----------------
  1072. By setting SysopKeys% = 1 (after calling INITIALIZE), you can utilize the
  1073. arrow keys for remote input. This could be used for moving highlight bars
  1074. etc. (see the DFDEMO for an example).  Using the arrow keys from remote can
  1075. present difficulties because the terminal program the caller is using may
  1076. have redefined the arrow keys. Qmodem is a good example. Normally the up
  1077. arrow in Qmodem activates the scroll back buffer. However, if you switch
  1078. Qmodem into DoorWay mode (ALT =), the arrow keys can be used. I do not know
  1079. if this is possible with other terminals (feedback anyone?).  If you do
  1080. utilize the arrow keys, you would be wise to provide an alternative method
  1081. of input for those callers who cannot use their arrow keys.
  1082.  
  1083. In addition, set Sysopkeys% = 1 only when arrow input is required then
  1084. immediately set SysopKeys% = 0 since capital H, K, M, and P are also
  1085. interpreted as arrow keys when SysopKeys% = 1.
  1086.  
  1087. Turning off the Status lines.
  1088. -----------------------------
  1089. If for some reason you do not want the 2 Status lines at the bottom of the
  1090. screen to show, you may blank those out at any time with the following.
  1091.  
  1092.  No.Status% = 1
  1093.  ClrScrn Black
  1094.  
  1095. To turn the Status lines back on just set No.Status% = 0.
  1096.  
  1097. Returning control to programmer upon carrier loss
  1098. -------------------------------------------------
  1099. There may be instances where the programmer needs to do some clean-up when
  1100. a loss of carrier occurs before returning to the BBS. There are two variables
  1101. that allow you to do this. After calling INITIALIZE, set Auto.Recycle% = 0.
  1102. If carrier is lost, the variable NoCarrier% is set equal to 1. One way to 
  1103. handle this is to check NoCarrier% after each In.Put, Enter, or More 
  1104. statement. If NoCarrier% = 1, your door will NOT stop for user input. For
  1105. example:
  1106.  
  1107.    In.Put 0, 0, 11, 0, 1, "Prompt > ", 10, 1, 1
  1108.    IF NoCarrier% = 1 THEN GOTO HandleIt
  1109.  
  1110. If the door was sitting at the In.Put prompt when carrier loss occurred, it
  1111. would immediately come out of it and process the next statement. You must be
  1112. VERY CAREFUL when using this option. Make sure you TEST IT THOROUGHLY!!!
  1113.  
  1114. After you have done your clean-up, be sure to call Exit.Door "Y" to terminate
  1115. the door as you normally would.
  1116.  
  1117. System.File% Variable
  1118. ---------------------
  1119. The value of System.File% will tell you which BBS file is being  used 
  1120. according to the following values:
  1121.  
  1122.         1 = PCBOARD.SYS                    6 = DORINFOx.DEF
  1123.         2 = USERS.SYS                      7 = SFDOORS.DAT                    
  1124.         3 = DOOR.SYS                       8 = USERINFO.DAT
  1125.         4 = CALLINFO.BBS                   9 = GTUSER.BBS
  1126.         5 = Not Used                      10 = TRIBBS.SYS
  1127.  
  1128.  
  1129. DOORFRAME v1.8 - Users Guide - Page 22
  1130.  
  1131. Fossil Driver Support
  1132. ---------------------
  1133. DoorFrame supports the use of Fossil drivers.  To tell your Door to use the
  1134. Fossil driver instead of the standard COM ports, just put /FD on the command
  1135. line when running the door. For example:
  1136.      MYDOOR MYDOOR.CFG /FD
  1137. indicates that a Fossil driver is present and should be used. If no Fossil
  1138. driver is detected, DoorFrame will print a message to that effect and exit
  1139. the door gracefully.
  1140.  
  1141. Environment Variables
  1142. ---------------------
  1143. DoorFrame supports COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  1144. COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  1145. number after the configuration filename. Let's assume your Door is
  1146. called FOOBAR and you want to use COM1 and IRQ5. The command line
  1147. passed to your Door would be:
  1148.     FOOBAR FOOBAR.CFG /5  or
  1149.     FOOBAR FOOBAR.CFG /%IRQ%  for the environment variable.
  1150. The /5 tells DoorFrame to use IRQ5 rather than the standard IRQ4 that
  1151. is normally used with COM1. No /x parameter is needed for the standard IRQ's.
  1152.  
  1153. When specifying the location of the system file on line 1 of the doors .CFG
  1154. file, you may use the environment variables %pcbdrive%, %pcbdir%, %pcbnode%,
  1155. and %wcnodeid%. Some examples:
  1156.  PCBoard: 
  1157.    USERS.SYS in C:\PCB           - %pcbdrive%%pcbdir%\USERS.SYS
  1158.    USERS.SYS in C:\PCB\NODE1     - %pcbdrive%%pcbdir%\NODE%pcbnode%\USERS.SYS
  1159.  
  1160.  Wildcat!:
  1161.    USERINFO.DAT in C:\WC\NODE1   - C:\WC\NODE%wcnodeid%
  1162.  
  1163. Non-PCBoard systems may use the PCB environment variables by setting them
  1164. in either AUTOEXEC.BAT or in the batch that runs the door. For example:
  1165.  SET PCBDRIVE=C:
  1166.  SET PCBDIR=\BBSDIR
  1167.  SET PCBNODE=1
  1168.  
  1169.